doc clarification (closing #110)

diff --git a/utf8proc.h b/utf8proc.h
index f5cc1e1ef8674c87fbac59cb790e2d433ffe3dcd..d12b721a6c5245d7633218a1de61dd24d78f63a2 100644 (file)
--- a/utf8proc.h
+++ b/utf8proc.h
@@ -595,7 +595,8 @@ UTF8PROC_DLLEXPORT utf8proc_ssize_t utf8proc_reencode(utf8proc_int32_t *buffer,
  *              matching the rules in Unicode 8.0.0.
  *
  * @warning If the state parameter is used, `utf8proc_grapheme_break_stateful` must
- *          be called IN ORDER on ALL potential breaks in a string.
+ *          be called IN ORDER on ALL potential breaks in a string.  However, it
+ *          is safe to reset the state to zero after a grapheme break.
  */
 UTF8PROC_DLLEXPORT utf8proc_bool utf8proc_grapheme_break_stateful(
     utf8proc_int32_t codepoint1, utf8proc_int32_t codepoint2, utf8proc_int32_t *state);